/****************************************************************************
**
** Copyright (C) 2010 Tieto Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Tieto Corporation (info.ostrava@tieto.com)
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Tieto.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Tieto gives you certain additional
** rights.  These rights are described in the Tieto Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Tieto at info.ostrava@tieto.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef BACKGROUNDTASK_H
#define BACKGROUNDTASK_H

#include <QtCore/QThread>

/**
 * Run background task in separate thread
 */
class BackgroundTask : public QThread // TODO synchronation
{
    Q_OBJECT

public:

    /**
     * Default constructor
     * @param name task name
     */
    BackgroundTask(const QString name, QObject *parent = 0);

    /**
     * Runs background task
     */
    void run();

    /**
     * Is canceled?
     * @return true if task has been canceled
     */
    bool isCanceled() const;

public slots:

    /**
     * Cancels background task
     */
    void cancel();

signals:

    /**
     * Emited when background task is canceled
     */
    void canceled();

    /**
     * Emited when progress range changes
     */
    void progressRangeChanged(int minimum, int maximum);

    /**
     * Emited when progress changes
     */
    void progressValueChanged(int progressValue);

protected :

    /**
     * Background task method
     */
    virtual void doRun() = 0;

    /**
     * Background task cancel method
     */
    virtual void doCancel() = 0;

    /**
     * Task name
     */
    QString _name;

    /**
     * Canceled flag
     */
    bool _isCanceled;       

};

#endif // BACKGROUNDTASK_H
